

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Apache Usergrid Documentation &mdash; Apache Usergrid 2.x documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Apache Usergrid 2.x documentation" href="index.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        

        
          <a href="index.html" class="icon icon-home"> Apache Usergrid
        

        
        </a>

        
          
          
            <div class="version">
              2.x
            </div>
          
        

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
          
          
              <p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Using Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="using-usergrid/creating-account.html">Creating a Usergrid Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-usergrid/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-usergrid/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-usergrid/using-the-api.html">Using the API</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Storage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-storage/optimizing-access.html">Data Store Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-storage/collections.html">Collections</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-storage/entities.html">Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Queries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="data-queries/querying-your-data.html">Querying your data</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-queries/query-parameters.html">Query parameters &amp; clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-queries/operators-and-types.html">Query operators &amp; data types</a></li>
<li class="toctree-l1"><a class="reference internal" href="data-queries/advanced-query-usage.html">Advanced query usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Entity Connections</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="entity-connections/connecting-entities.html">Connecting entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity-connections/retrieving-entities.html">Retrieving connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Push Notifications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/overview.html">Push notifications overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/adding-push-support.html">Adding push notifications support</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/getting-started.html">Getting started with push notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/tutorial.html">Tutorial: Push notifications sample app</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/registering.html">Registering with a notification service</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/creating-notifiers.html">Creating notifiers</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/managing-users-and-devices.html">Managing users and devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/creating-and-managing-notifications.html">Creating and managing notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="push-notifications/troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption"><span class="caption-text">Security &amp; Authentication</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security &amp; token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users &amp; app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/facebook-sign.html">Facebook sign in</a></li>
<li class="toctree-l1"><a class="reference internal" href="security-and-auth/securing-your-app.html">Security best practices</a></li>
</ul>
<p class="caption"><span class="caption-text">User Management &amp; Social Graph</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user-management/user-management.html">User management &amp; social graph</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-management/working-user-data.html">Working with User Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-management/group.html">Working with group data</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-management/activity.html">Activity</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html">Social Graph Connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-management/messagee-example.html">App Example - Messagee</a></li>
</ul>
<p class="caption"><span class="caption-text">Geo-location</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="geolocation/geolocation.html">Geolocating your Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Assets &amp; Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters &amp; Events</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html">Creating &amp; incrementing counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
<li class="toctree-l1"><a class="reference internal" href="counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
</ul>
<p class="caption"><span class="caption-text">Organizations &amp; Applications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization &amp; application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html">Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#models">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#sub-types">Sub-Types</a></li>
</ul>
<p class="caption"><span class="caption-text">Client SDKs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="sdks/tbd.html">COMING SOON...</a></li>
</ul>
<p class="caption"><span class="caption-text">Installing Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/deployment-guide.html">Usergrid 2.1.0 Deployment Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">More about Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/presos-and-videos.html">Presentations &amp; Videos</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
</ul>

          
        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">Apache Usergrid</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
    <li>Apache Usergrid Documentation</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/README.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="apache-usergrid-documentation">
<h1>Apache Usergrid Documentation<a class="headerlink" href="#apache-usergrid-documentation" title="Permalink to this headline">¶</a></h1>
<p>Usergrid documentation is written in
<a class="reference external" href="https://help.github.com/articles/markdown-basics/">Markdown</a> (*.md)
and RST (.rst) formats and we use the Python based
<a class="reference external" href="http://sphinx-doc.org/">Sphinx-Docs</a> documentation system to
transform our Markdown and RST files to HTML format.</p>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
<p>Sphinx requires Python and pip. Once you have Python, you can install
sphinx and pip like so:</p>
<div class="highlight-python"><div class="highlight"><pre>$ sudo easy_install sphinx
$ sudo easy_install pip
</pre></div>
</div>
</div>
<div class="section" id="how-to-build-the-usergrid-documentation-using-sphinx">
<h2>How to build the Usergrid documentation using Sphinx<a class="headerlink" href="#how-to-build-the-usergrid-documentation-using-sphinx" title="Permalink to this headline">¶</a></h2>
<p>Sphinx runs via a Makefile in this, the docs directory. So, cd to this
directory and make html:</p>
<div class="highlight-python"><div class="highlight"><pre>cd $usergrid/docs
make clean html
</pre></div>
</div>
</div>
<div class="section" id="how-to-update-the-usergrid-docs">
<h2>How to update the Usergrid docs<a class="headerlink" href="#how-to-update-the-usergrid-docs" title="Permalink to this headline">¶</a></h2>
<p>Find the Markdown (.md) or reST (.rst) files that you need to change,
edit them and then run <code class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span> <span class="pre">html</span></code> to generate the HTML into the
<code class="docutils literal"><span class="pre">target/html</span></code> directory, where you can preview your changes.</p>
<div class="section" id="note-the-difference-between-rst-and-markdown-files">
<h3>Note the difference between RST and Markdown files<a class="headerlink" href="#note-the-difference-between-rst-and-markdown-files" title="Permalink to this headline">¶</a></h3>
<p>Note that Sphinx&#8217;s native format is
<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> (RST)
and not Markdown. This causes some issues. For example, using Sphinx
directives in Markdown files sometimes works and sometimes does not. RST
is a different format than Markdown and it has a different set of
directives, some very useful for organizing a large set of documentation
files.</p>
</div>
<div class="section" id="updating-the-table-of-contents">
<h3>Updating the Table of Contents<a class="headerlink" href="#updating-the-table-of-contents" title="Permalink to this headline">¶</a></h3>
<p>The Table of Contents for the documentation is in index.rst, which ties
everything together with a series of RST <strong>toctree</strong> directives. All
other files should be written in Markdown, unless they need some special
RST directives that will not work in Markdown.</p>
</div>
<div class="section" id="dealing-with-other-tables">
<h3>Dealing with other tables<a class="headerlink" href="#dealing-with-other-tables" title="Permalink to this headline">¶</a></h3>
<p>A note about tables. Markdown and reST do not have very good table
support. Simple tables are easy to do and you can find examples (e.g.
connecting-entities.md) but for tables with multiple lines in each cell,
you&#8217;ll probably want to use a raw HTML table, and there are plenty of
examples of that around too.</p>
</div>
</div>
<div class="section" id="how-to-publish-the-usergrid-docs-to-usergrid-website">
<h2>How to publish the Usergrid docs to Usergrid website<a class="headerlink" href="#how-to-publish-the-usergrid-docs-to-usergrid-website" title="Permalink to this headline">¶</a></h2>
<p>First you generate the HTML for the docs from the Markdown and reST
sources like so:</p>
<div class="highlight-python"><div class="highlight"><pre>cd $usergrid/docs
make clean html
</pre></div>
</div>
<p>To update the Usergrid website you must copy the udpated docs files from
<code class="docutils literal"><span class="pre">target/html</span></code> directory to the website directory at the root of the
Usergrid project, i.e. <code class="docutils literal"><span class="pre">${usergrid-project-dir}/website/docs</span></code>.</p>
<p>You can do this by running the script <code class="docutils literal"><span class="pre">update-website.sh</span></code>.</p>
<p>Once you&#8217;ve done that then you should follow the instructions in the
website/README.md file, which explains how to update the website.</p>
</div>
<div class="section" id="updating-the-rest-api-reference">
<h2>Updating the REST API reference<a class="headerlink" href="#updating-the-rest-api-reference" title="Permalink to this headline">¶</a></h2>
<p>The REST API documentation in <code class="docutils literal"><span class="pre">rest-endpoints/api-docs.md</span></code> is
generated from a Swagger file in the directory <code class="docutils literal"><span class="pre">src/main/resources</span></code>,
so DO NOT edit that file directly.</p>
<p>If you need to update the REST API docs, you should edit the
usergrid-swagger.yaml file and then re-generate the file.</p>
<p>If you need to change the formatting of the REST API docs, then you will
need to edit the Mustache templates in <code class="docutils literal"><span class="pre">src/main/resource</span></code> and you may
need to edit the Groovy script that does the generation:
<code class="docutils literal"><span class="pre">src/main/groovy/usergrid.ApiDocGenerator</span></code>.</p>
<p>You will need: * Groovy 2.x *
<a class="reference external" href="https://github.com/spullara/mustache.java">Mustache.java</a></p>
<p><strong>NOTE</strong>: Mustache.hava is not in Maven Central so unfortunately, you
will have to Git Clone Mustache.java before you can run the generation
script.</p>
<p>This is the command to run the generation:</p>
<div class="highlight-python"><div class="highlight"><pre>groovy src/main/groovy/usergrid/ApiDocGenerator.groovy
</pre></div>
</div>
<p>The script will update the file <code class="docutils literal"><span class="pre">rest-endpoints/api-docs.md</span></code> and when
you are happy with your update you should commit and push that file with
Git.</p>
</div>
</div>


           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2013-2015, Apache Usergrid.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'2.x',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>